<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Path</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Path</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This class provides functionality to resolve paths with different protocols  such as flow, php, get etc... for use in xml files such as actions, validators  queries, etc..</p>
<p class="description"><p>In many situations, such as <em>src</em> attributes of sitmap tags, query parameters,  etc.... a protocol can be specified along with the desired variable in order  to access data such as Flow, $_REQUEST, URIs, etc....  Path provides a standardized manner in which to access this data. For example,  a <em>map:xsl</em> tag will have a <em>src</em> attribute defining the location  of the XSL file. The defaut protocol in this case would be <em>string</em> so  that, if no protocol is specfified, the value will be handled as a string. But  other protocols can be used to resolve this value such as <em>flow://some/var</em>  or <em>php:some_php_eval_expression</em> or <em>get://some/get/var</em>, etc.. Not  all situations/tags accept multi-protocols. Please refer to the tag references  for details.</p><p>Currently available protocols are:  -<strong>get</strong><ul><li>$_GET variables</li><li><strong>post</strong> - $_POST variables</li><li><strong>globals</strong> - $GLOBALS variables</li><li><strong>request</strong> - $_REQUEST variables</li><li><strong>session</strong> - $_SESSION variables</li><li><strong>files</strong> - $_FILES variables</li><li><strong>server</strong> - $_SERVER variables</li><li><strong>cookie</strong> - $_COOKIE variables</li><li><strong>registry</strong> - Registry data - a special subest of the session handling.</li><li><strong>flow</strong> - Flow variables</li><li><strong>php</strong> - PHP evaluation - Note that a <em>return</em> statement is automatically</li><li><strong>string</strong> - Plain string</li></ul>  In the case of XML files such as the sitemap, queries, etc... a path variable  is simply specified as a standard URI such as:  <div class="src-code"><ol><li><div class="src-line">&lt;<span class="src-sym">!</span>--&nbsp;<span class="src-id">sample&nbsp;sitemap&nbsp;tag&nbsp;</span>--&gt;</div></li>
<li><div class="src-line">&nbsp;&lt;<span class="src-id">map</span>:<span class="src-id">xsl&nbsp;src</span>=<span class="src-str">&quot;flow://my/xsl&quot;</span>/&gt;</div></li>
<li><div class="src-line">&nbsp;</div></li>
<li><div class="src-line">&nbsp;&lt;<span class="src-sym">!</span>--&nbsp;<span class="src-id">sample&nbsp;query&nbsp;parameter&nbsp;</span>--&gt;</div></li>
<li><div class="src-line">&nbsp;&lt;<span class="src-id">param&nbsp;name</span>=<span class="src-str">&quot;currentTime&quot;&nbsp;</span><span class="src-key">default</span>=<span class="src-str">&quot;php:time()&quot;</span>/&gt;</div></li>
</ol></div></p></p>
		<p class="notes">
			Located in <a class="field" href="_kernel---path.php.html">/kernel/path.php</a> (line <span class="field">59</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
												<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#get" title="details" class="method-name">get</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$defaultProtocol</span> = <span class="var-default">'string'</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#parseInlineFlow" title="details" class="method-name">parseInlineFlow</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">object class</span>
										<a href="#singleton" title="details" class="method-name">singleton</a>
										()
									</div>
								
																												</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodget" id="get"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method get</span> (line <span class="line-number">76</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a string based on given protocol://path</p>
	<ul class="tags">
				<li><span class="field">return:</span> value of variable</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">string</span>
		<span class="method-name">
			get
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$defaultProtocol</span> = <span class="var-default">'string'</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$path</span><span class="var-description">: path to resolve/render</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$defaultProtocol</span><span class="var-description">: (optional) default protocol if none given</span>			</li>
				</ul>
		
			
	</div>
<a name="methodparseInlineFlow" id="parseInlineFlow"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method parseInlineFlow</span> (line <span class="line-number">212</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Resolves inline flow vars.</p>
<p class="description"><p>This method will look for curly bracketed values in a string  and return a flow expression.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> path with resolved inline flow expressions</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">string</span>
		<span class="method-name">
			parseInlineFlow
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$string</span><span class="var-description">: path to analyze, returns by ref</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsingleton" id="singleton"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method singleton</span> (line <span class="line-number">265</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a class singleton.</p>
	<ul class="tags">
				<li><span class="field">return:</span> singleton instance</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">object class</span>
		<span class="method-name">
			singleton
		</span>
				()
			</div>
	
		
			
	</div>

						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Thu, 02 Aug 2007 17:35:21 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
	</p>
	</div></body>
</html>